home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / dev / misc / gadoc.lha / GAdoc.c / gadoc.readme < prev    next >
Encoding:
Text File  |  1995-03-28  |  2.0 KB  |  62 lines
  1. Short:    V1.2, autodocs: TeXinfo file, incl. xref
  2. Uploader: leibrock@fsinfo.cs.uni-sb.de (Gerhard Leibrock)
  3. Author:   leibrock@fsinfo.cs.uni-sb.de (Gerhard Leibrock)
  4. Type:     dev/misc
  5.  
  6. GAdoc (Get Auto DOC) is a program which extracts autodoc-style comments
  7. out of any file and generates a two part TeXinfo file out of it.
  8.  
  9.  
  10.     THIS PROGRAM NEEDS TEX OR MAKEINFO TO BE OF ANY USE!
  11.  
  12.  
  13. Warning:
  14.     This program is missing some of the features that can be
  15.     found in the autodoc program from Commodore:
  16.  
  17.     * Lines *strictly* limited to 80 chars/line
  18.     * No word wrapping, if a line is longer than 80 chars
  19.     * Ignores first character of each line
  20.     * Only generates texinfo files, nothing else.
  21.  
  22. Features:
  23.     * Supports standard autodocs
  24.     * Can extract internal autodocs
  25.     * Can extract only autodocs with a special ID
  26.       (Possible to write autodocs in different languages and
  27.       keep them in one file).
  28.     * Supports main program header, as introduced with ROBODdoc from
  29.       weertj@euronet.nl, which didn't work very well on my Amiga
  30.       (So I wrote my own one).
  31.     * Supports xrefs to other files and within the autodoc itself.
  32.  
  33. Compiled with gcc263; runs under NetBSD, Amiga OS, Solaris.
  34.  
  35. (Will NOT run under SM-DOS, because of the filename extensions used :)
  36.  
  37. GAdoc v1.2 was written by Gerhard Leibrock
  38.  
  39.     Email:    leibrock@fsinfo.cs.uni-sb.de
  40.         (fach5@cipsol.cs.uni-sb.de)
  41.  
  42.     Smail:
  43.         Gerhard Leibrock
  44.         Neuhaeuselerstr. 12
  45.         66459 Kirkel, Germany
  46.  
  47. This is an UPDATE of version 1.1. I added the ``-s<ID>'' flag, to make
  48. it possible to write autodocs in different languages and keep them in
  49. one file. Gadoc can now create icons for use under amiga dos with the
  50. ``-aicon'' option.
  51. Also new is the file "2PagesTexi.scr" for use under amigados. It will
  52. create a booklet with dvidvi out of the .dvi file.
  53.  
  54. VERY IMPORTANT:
  55. ---------------
  56. This software is subject to the ``Standard Amiga FD-Software Copyright Note''
  57. It is Cardware as defined in paragraph 4.c.
  58. If you like it and use it regularly please send a postcard to the author.
  59. For more information please read ``AFD-COPYRIGHT'' (Version 1 or higher).
  60.  
  61.  
  62.